home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / pcboard / hb_tb12.zip / STB.DOC < prev    next >
Text File  |  1996-01-02  |  7KB  |  178 lines
  1.                 Simple Time Bank Documentation
  2.  
  3.  
  4.  
  5. This PPE is freeware and may be distributed freely, but I do
  6. retain all copyrights. It is free of any backdoors or trojan code, it works
  7. for me and should for you, but I make no guarantees. You assume all
  8. responsibility for use of this code.
  9.  
  10. Now that that's out of the way:
  11.  
  12. This PPE is a simple time bank- no frills, no gambling, no transfers - just
  13. a place for users to store time and/or bytes for later use. It will honor all
  14. PCBoard restrictions you set, and the amounts allowed for deposit/withdrawal
  15. on a daily/maximum basis are sysop configurable.
  16.  
  17. Installation
  18. ============
  19.  
  20. 1. Extract the PPE and accompanying files to a directory.
  21.  
  22. 2. Edit any of the display files to suite your own style.
  23.  
  24. 3. To your CMD.LST, add an entry to make the bank available to your
  25.    callers. See your PCBoard Manual if you are unsure how to do this.
  26.  
  27.  
  28. Thanks all there is to it. The first time the PPE is run, it will create
  29. the necessary database files it needs.
  30.  
  31.  
  32. FILES
  33. =====
  34.  
  35. The following files should be in your directory:
  36.  
  37. FILE_ID.DIZ     - archive description
  38. STB.DOC         - this file
  39. HISTORY.TXT     - History file containing changes/updates
  40. STB.PPE         - Time Bank PPE
  41. STB.CFG         - Sysop Configuration file (commented)
  42. HELP            - Help display used by the PPE
  43. STBWELC         - First time user display
  44. MENU            - Main Menu Display
  45. PROMPTS         - Prompts used by STB.PPE
  46.  
  47. Files that the PPE will create and maintain:
  48.  
  49. STB.DBF         - Database file with bank information for each user who
  50.                   uses the time bank.
  51. NAME.NDX       - Index of names for fast lookup and retrieval
  52.  
  53. Files that may exist, but don't have to:
  54.  
  55. STBTWIT.LST     - List of users names, 1 per line, that aren't allowed access
  56.                   to the time bank. If these users try to enter, they will
  57.                   displayed a short message and returned to the BBS.
  58.  
  59.  
  60.  
  61. Config File
  62. ===========
  63.  
  64. The STB.CFG file is commented at the end. Only the first six lines are
  65. important and are required.  This file will allow you to set the limits on
  66. the number of minutes and bytes allowed to be stored in the Time Bank,
  67. and withdrawn later, as well as maximum amounts that can be stored.
  68.  
  69.  
  70. Display Files
  71. =============
  72.  
  73. There are 3 display files used by STB. All can have Graphics, Language, and
  74. security specific versions (or combinations of them).
  75.  
  76. STBWELC    -  This file is displayed when a user has never been in the
  77.               time bank before. You can use it to list the limits you have
  78.               set, rules, whatever you feel is important.
  79.  
  80. MENU       -  This is the main menu display of the Time Bank. You can edit
  81.               it to make the bank appear seemless with the rest of your BBS.
  82.  
  83. HELP       -  This is the file displayed when the user requests help in the
  84.               time bank. It should display all the choices available.
  85.  
  86.  
  87. Twit File
  88. =========
  89.  
  90. You can prevent specific users from accessing the Time Bank by placing
  91. their name in the special STBTWIT.LST file. Use their real name, 1 per
  92. line. They will be displayed a quick message, then sent back to the BBS.
  93.  
  94.  
  95. Prompt File
  96. ===========
  97.  
  98. The PPE has an editable PROMPT file that can have Language specific variations.
  99. I will Warn you that I recommend AGAINST editing the Report Lines. The OPTEXT
  100. macro is used heavily, and specific lines will contain specific information.
  101.  
  102. Now a Brief description of the lines.
  103.  
  104. Line 1      -   Displayed to STBTWIT.LST users
  105. Line 2      -   Database Error message
  106. Lines 3-9   -   Menu if MENU file doesn't exist
  107. Line 10     -   Expert Mode Main Prompt
  108. Line 11     -   Normal Mode Main Prompt
  109. Line 12     -   Used with other lines.
  110. Line 13     -   Displayed when user quits the time bank
  111. Line 14-34  -   REPORT LINES (see below)
  112. Line 35     -   User can withdraw time due to upcoming Expedited BBS Event
  113. Line 36-37  -   Displays minutes/bytes in bank before a transaction
  114. Line 38-39  -   Time/Bytes transaction prompt
  115. Line 40-41  -   OPTEXT for prompts 38, 39, and 43
  116. Line 42     -   Part 1 - Indicating unable to complete request due to CFG limits
  117. Line 43     -   Part 2 -  "     "       "       "
  118. Line 44     -   Part 3 -  This and the above 2 lines create the full prompt
  119. Line 45     -   Indicates PCBoard didn't allow the change in time
  120. Line 46     -   Display when user has unlimited bytes and attempts a byte
  121.                 transaction
  122.  
  123.  
  124. Reports lines 14-34
  125.  
  126. These 21 lines should be edited very carefully if at all (I'd recommend leaving
  127. them alone). But if you're daring, heres the format. Note: BLANK indicates
  128. you can do whatever, there is nothing special about the line.
  129.  
  130. LINE(s)     DESCRIPTION
  131. 14-17       BLANK
  132. 18          Current formatted Date and time in OPTEXT, field length is 22.
  133. 19-20       BLANK
  134. 21          Date of last Time Transaction in OPTEXT, field minimum of 12
  135. 22          Time in Bank & Max allowed - in OPTEXT,
  136.             field length is 20, right justified if you want things to line up
  137.             all the time combination fields will be in the format
  138.             ###### / ###### min
  139. 23          Time Deposited today so far & Daily maximum - in OPTEXT
  140.             field length is 20, right justified
  141. 24          Time Withdrawn today so far & Daily maximum - in OPTEXT
  142.             field length is 20, right justified
  143. 25-26       BLANK
  144. 27          Date of last Byte Transaction in OPTEXT, field minimum of 12
  145. 28          Bytes in Bank & Max allowed - in OPTEXT,
  146.             field length is 20, right justified if you want things to line up
  147.             all the bytes combination fields will be in the format
  148.             #######/####### KB.
  149.             and the values will be converted to kilobytes
  150. 29          Bytes Deposited today so far & Daily maximum - in OPTEXT
  151.             field length is 20, right justified
  152. 30          Bytes Withdrawn today so far & Daily maximum - in OPTEXT
  153.             field length is 20, right justified
  154. 31-34       BLANK
  155.  
  156.  
  157. Support
  158. =======
  159.  
  160. Support for this, and all my PPE's can be obtained on my BBS.
  161.  
  162. I will provide support and accept bug reports via Fidonet Netmail and
  163. internet e-mail, but can only answer BBS and e-mail messages. Netmail replies
  164. will be placed on the BBS unless an e-mail address is included.
  165.  
  166. Herbert Bushong
  167. BBS     : 318-468-3385
  168. Internet: herbert.bushong@bbread.pecan.com
  169. Fidonet : 1:19/19
  170. or on Intelec and U'NI-net
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.